Shareware Super Platinum 8

home *** CD-ROM | disk | FTP | other *** search

/ Shareware Super Platinum 8 / Shareware Super Platinum 8.iso / mac / BACKUP / INST150A.ZIP;1 / INSTALL.DOC < prev next >

Wrap

Text File | 1993-03-14 | 17.1 KB | 428 lines

INSTALL.EXE Version 1.50 1.0 INTRODUCTION A convienent and user friendly method for your users to install new programs onto their systems. Unlike other installation programs or standard batch file methods, INSTALL will not transfer itself ,its configuration file, message files, any other files used to install your programs onto the user's hard disk taking up your users precious space. INSTALL begins by displaying a title screen with a brief description to the user of what will take place. Next, an optional message screen is displayed. This message screen uses a standard ASCII text file of up to 250 lines of text which you create using your favorite word processer. The user can page up and down or print it to refer to after the installation process is complete. INSTALL then prompts the user for the correct source and destination drives\paths, after which it checks for existing information within the destination directory. If the backup option is turned on, a BAK subdirectory is created. INSTALL begins the installation process by backing up any existing information into the BAK subdirectory, then copies files from the source disk onto the destination drive\path while displaying the percentage of completion for the disk graphically. Using the configuration file "INSTALL.CFG", INSTALL can be customized to fit your particular needs. Below is the available keywords used for configuring INSTALL along with an explanation for each. Each keyword can be in upper or lower case, followed by an equal "=" sign, then the required parameter. You may place any amount spaces between the keyword, equal sign, and the required parameter to improve readability. Comments may be placed anywhere within the file and should begin with a single quote character "'" or semi-colon ";". INSTALL also incorporates automatic detection and decompression of files compressed using PKUNZIP.EXE*. The file PKUNZIP.EXE* must be present on all disks to be installed that contain compressed files. Automatic decompression can be turned off by using '-norun' parameter with the ZIPPARM keyword (See below). If you have one of those monochrome monitors which INSTALL is unable to detect, a "/m" may be used on the command line to force the monchrome mode (Eg: INSTALL /m). 2.0 KEYWORDS The following list contains all keyword options available to INSTALL. Note either the full keyword name or the reduced three character keyword (noted in brackets) may be used. INSTALL is case insensitive when searching the configuration file for valid keywords and spaces may be used between the keyword and parameter as required to make your configuration file more readable. By using braces '{}', the result of the Source and Destin keyword variables can be imbeded in certain parameters. For example, say you need to rename a file on the destination drive before you start installation, but it will be unknown until run time what drive and path was chosen. By imbeding the Destin keyword on the parameter line, INSTALL will replace the definition with the correct value at run time. These keywords for the Source and Destin are only available for DEL, DosCommandFirst, DosCommandLast, RunFirst and RunLast keywords. DosCommandFirst = ren {Destin}run.bat run.old - or - DCF = ren {DST}run.bat run.old Comments and blank lines may be placed anywhere within the configuration file. Each comment line should begin with a single quote character or semicolon. Refer to the sample configuration file included with the program for examples of how to setup and use the configuration file. *** KEYWORD LISTING *** BACKUP [BKP] = no Prevents the creation of the BAK subdirectory and subsequent backup of any existing data into it. Default if not specified is yes COMPANY [CMP] = company name * Registered Version Only Replaces the company name at the top center of the display screen. DEL [DEL] = filename Name of any files to be deleted after INSTALL has backed up any existing data in the destination directory. A maximum of 20 filenames may be specified Only files within the destination drive\path may be deleted. Standard DOS wildcards, question marks "?" and/or asterisks "*" , may be used. Multiple filenames can be placed in sequence with a single keyword if they are separated by commas. Example1: Example2: DEL = PROGRAM2.EXE DEL = PROGRAM2.EXE, OVERLAY.*, MNTH??92.DAT DEL = OVERLAY.* DEL = MNTH??92.DAT DESTIN [DST] = drive:\path Preferred destination drive\path for files to be installed into. If omitted, a default of C:\ is used. The user has the option of changing this prior to starting the installation. INSTALL will verify that the drive\path exists and, if not, will prompt the user for creation prior to starting. Example: DESTIN = C:\MYPROG DISKS [DSK] = n The number of disks to be installed. After each disk is complete, the user will be prompted to install a new disk in the Source drive. If this keyword is omitted, a default of one disk is assumed. Example: DISKS = 3 DISKSPACE [SPC] = xxxxx * Registered Version Only Defines the minimum allowable amount of disk space that must exist on the destination drive prior to starting installation. Parameter may contain commas for clarity. Example1: Example2: DiskSpace=2000000 SPC = 2,000,000 DOSCOMMANFIRST [DCF] = any_dos_command * Registered Version Only Up to 25 Dos commands can be defined to be run in the background before installation of disks. Use caution when using this keyword, any characters that would be output to the screen will be displayed over the current screen display. This keyword is only designed to run Dos commands in the background. The original screen will be restored after running all of the Dos commands specified in case this should happen. If you plan to use this keyword, be sure to redirect any output to the nul device using standard the Dos redirection " > nul". Multiple commands can be placed in sequence with a single keyword if they are separated by commas. Example1: DOSCommandFirst = copy {Destin}run.bat {Destin}run.old > nul Example2: DCF = copy {Dst}run.bat {Dst}run.old > nul, ren {DST}prog.exe prog.old NOTE: In the above example, {Destin} will be replaced with the correct destination drive and path as selected by the user prior to starting in the format of {drive}:\{path}\. DOSCOMMANLAST [DCL] = any_dos_command * Registered Version Only Up to 25 Dos commands can be defined to be run in the background after installation of disks. Use caution when using this keyword, any characters that would be output to the screen will be displayed over the current screen display. This keyword is only designed to run Dos commands in the background. The original screen will be restored after running all of the Dos commands specified in case this should happen. If you plan to use this keyword, be sure to redirect any output to the nul device using standard the Dos redirection " > nul". Multiple commands can be placed in sequence with a single keyword if they are separated by commas. Example1: DOSCommandLast = copy {Source}tmp.bat {Destin}run.bat > nul Example2: DCL = copy {Src}tmp.bat {Dst}run.bat > nul, ren {DST}tmp.exe tmp.old NOTE: In the above example, {Source} and {Destin} will be replaced with the correct drive and path as selected by the user in the format of {drive}:\{path}\ prior to starting. EXCLUDEFILE [EXF] = source_file_name * Registered Version Only Any files located on the source drive to be excluded from being installed on the destination drive. INSTALL automatically excludes itself, the configuration file, message file and PKUNZIP* file. Up to 20 files additional files may be excluded by listing each one with this keyword. Dos wildcards are valid. Multiple file names can be placed in sequence with a single keyword if they are separated by commas. Example1: Example2: ExcludeFile = RUN.BAT EXF = RUN.BAT, MEMTEST.EXE ExcludeFile = MEMTEST.EXE GRAPH [GPH] = no Prevents the graphic display of the percentage completed while installing. It is suggested to use this keyword when only decompressing one or two zip files. INSTALL cannot determine the percentage of completion while PKUNZIP* is working. Using this keyword, the graph is replaced showing only the name of the file being installed along with the number of files successfully installed out of the total number to be installed. Default is yes. INSTR [INS] = no Prevents the initial instruction page from being displayed. This page is normally displayed after the title page and informs the user of what will take place prior to starting. Default is yes. LABEL [LBL] = volume_name Used to verify the proper disk has been placed into the source drive. One Label keyword should be used for every disk to be installed. These keywords must be placed in the order of installation. Multiple labels can be placed in sequence with a single keyword if they are separated by commas. Example1: LABEL = PROGRAM (Defines the label for disk one) LABEL = FILES (Defines the label for disk two) Example2: LBL = PROGRAM,FILES,GRAPHICS MAIN [MAN] = filename (Special User Keyword Option Only) Main .EXE program being installed. This is only used in conjuction with the Rec keyword to define where configuration data is located. PRINT [PRT] = filename Allows a 250 line by 70 column message to be displayed in pages of 16 lines each. The message must be in ASCII format and reside on the first source disk only. Messages that exceed 16 lines in length are displayed on multiple pages. The user can select the next page, previous page, output the message in raw format to the printer, exit the installation process, or continue with the installation. Example: PRINT=MESSGE.TXT REC [REC] = type (Special User Keyword Option Only) Type of configuration data tagged onto the end of program. Can be either TYPE as in TYPE...END TYPE or NOTYPE as in Cr/Lf records. RUNFIRST [RFP] = program_name * Registered Version Only Allows an external program to be called prior to installation of disks. The program will be provided with both the source and destination drives passed as parameters when called. The program should be located on the first disk to be installed. Refer to RUNFIRSTWIN for additional display options. For example, certain setup processes may need to be performed prior to installation. Including this keyword, you can write a program that would be called to perform these setup routines. Upon program startup, you would check %1 parameter for the source drive\path and %2 for the destination drive\path. The format for drive\path is '{drive}:\{path}\' (C:\DESTIN\). Example: RUNFIRST=make.bat RUNFIRSTWIN [RFW] = yes * Registered Version Only Window parameter for the RUNFIRST keyword which tells INSTALL whether to run the program or batch file specified with the keyword in a window. INSTALL will open a nine line window at the bottom of the display screen for any output the calling program requires. The default is no window which is useful if your processes require no operator intervention or output to the screen while running. RUNLAST [RLP] = program_name * Registered Version Only Allows an external program to be called after the installation of all disks. The program will be provided with both the source and destination drives passed as parameters. The program should be located on the last disk to be installed. Refer to RUNLASTWIN for additional display options. For example, you may require certain processes to be performed on the destination drive after installation is done. Including this keyword, your program would be called to perform these processes. Upon program startup, you would check %1 parameter for the source drive\path and %2 for the destination drive\path. The format for drive\path is '{drive}:\{path}\' (C:\DESTIN\). Example: RUNLAST=make.bat RUNLASTWIN [RLW] = yes * Registered Version Only Window parameter for the RUNLAST keyword which tells INSTALL whether to run the program or batch file specified with the keyword in a window. INSTALL will open a nine line window at the bottom of the display screen for any output the calling program requires. The default is no window which is useful if your processes require no operator intervention or output to the screen while running. SOURCE [SRC] = drive:\path Source drive\path from which files will be installed from. If omitted, the default directory from which the program was invoked will be used. TITLE [TTL] = new title name Name or Title of program being installed (Max 45 characters). Using This optional keyword will invoke a title page to be displayed. ZIPPARM [ZIP] = {pkunzip parameters} This line should contain the parameters you require for those files to be 'unzipped' using PKUNZIP.EXE* (refer to the program PKUNZIP.EXE* for valid parameters). The default parameter that INSTALL uses is '-o' for overwriting existing files on the destination drive. If you plan to use only the -o parameter, this keyword is not required. INSTALL always uses it as the default parameter to prevent the PKUNZIP's overwrite prompt message from displaying over INSTALL's display screen. To disable automatic decompression, use the parameter '-norun'. Example ZIPPARM = -norun NOTE: Using -norun, compressed files will still be installed on the destination drive, but no decompression will take place. 3.0 RELEASE HISTORY 02/11/92 Ver 1.01 - Fixed bugs found when destination drive did not end with a backlash "\" character Backup option did not work properly if "NO" was specified Added option to change company name at top-center of screen 02/26/92 Ver 1.20 - Added the LABEL keyword to identify when the user has placed the proper install disk into the source drive 07/18/92 Ver 1.21 - Removed the message "Be sure to back-up existing data files before using." from the final Installation Complete box. Added the INSTR keyword to prevent the instruction page being displayed. 10/12/92 Ver 1.30 - Added external program capability with the RUNFIRST and RUNLAST keywords. Corrected bug found in identifying the proper drive\path when not found during source and destination verification. 10/29/92 Ver 1.40 - Added decompression capability via PKUNZIP.EXE* and the ability to locate those files that have been compressed using PKZIP.EXE*. Added RUNFIRSTWIN and RUNLASTWIN keywords for external programs to be run with or without a DOS window being opened. Corrected bug found in displaying full destination path name. Expanded message display capability from a single page to muliple. 11/15/92 Ver 1.41 - Corrected several bugs: a) Error detected when only zip files exist on source b) Error generated when widcards used for deletion routine Added several extended error messages Added GRAPH keyword to eliminate graphic display. Graph not effective when only decompressing one or two zip files. Ver 1.41a- Minor bug fix increasing stack space. 03/15/93 Ver 1.50 - Added four new keywords: DiskSpace, DosCommandFirst, DosCommandLast and ExcludeFile Enhanced message display by allowing paging back and forth through the message, outputting to the printer and allowing exiting or continuing with install. Fixed keyword input to allow blank parameters in configuration file. Upgraded error handling to not only detect, but display errors when they occur rather than just exiting to the system. Added imbeded source and destin keywords in selected parameters. Created separate shareware and registered versions. Added reduced three character keyword size option. Change configuration input routine to allow multiple names in the parameter line separated by commas. ----------------------------------------------------------------------------- We at PM Systems welcome any comments suggestions or user customizable features you may have. Please contact us at the address below. PM Systems 8385 Tulip Lane Chagrin Falls, Ohio 44023 (216) 543-8739 CompuServe 70253,2100 This software is registered in the Compuserve Shareware Database - ID #472 ----------------------------------------------------------------------------- * PKZIP.EXE and PKUNZIP.EXE is a product of PKWARE Inc.